Skip to content

docs: add online template links - #1

Merged
QuQingY merged 2 commits into
MetaCircleAI:mainfrom
QuQingY:docs-online-template-links
Aug 3, 2026
Merged

docs: add online template links#1
QuQingY merged 2 commits into
MetaCircleAI:mainfrom
QuQingY:docs-online-template-links

Conversation

@QuQingY

@QuQingY QuQingY commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add online ComfyResearch template links to documented reproduction pages and the first-graph tutorial.
  • Add bilingual page-header UI, styling, and template ID metadata.
  • Correct the Neural Mechanics and Saad-Solla template IDs.
  • Add source, build, i18n, translation, and visual contract coverage.

Validation

  • 81 docs tests passed.
  • English and Chinese docs builds passed.
  • 17 rendered pages contain template links; ordinary introduction/reference pages do not.
  • Local app health check passed on port 8042.

@JinxinWonderWorld JinxinWonderWorld left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request changes

P1 — Two generated links target template IDs that are not currently deployed by the online app. The live template API exposes the existing Neural Mechanics ID b15a6036-0e38-4f8f-84ba-8b763c408dc9 and the Saad–Solla ID de684a36-a2d5-440f-bb2b-3c249abb8270, but not the new b38ae9dd-735b-46c4-973f-a850a2a55544 or e399fd7d-e107-44d0-94b6-7e2159392253. Clicking those two CTAs therefore reaches the app's “Template link not found” path unless the online template service is deployed with the new records first. Please either deploy those records or use the live IDs.

P2 — The new tests cover only the English first-graph rendered link; they do not iterate all 16 reproduction pages or verify the Chinese rendered links and IDs. Also, open_template is not included in the i18n required-key assertions. Please add the missing coverage.

Local verification against this PR head: 88 relevant docs/README tests passed and the bilingual Sphinx build succeeded. GitHub Actions run 30783650008 is currently startup_failure with no jobs, so CI still needs a rerun or runner investigation.

Comment thread docs/en/examples/reproductions/Neural_Mechanics.md
Comment thread docs/en/examples/reproductions/saad_solla_plateau_reproduction.md
Comment thread tests/test_docs_build_contracts.py
Comment thread docs/conf.py
@QuQingY

QuQingY commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

Addressed the review feedback in 9ced321:

  • Preserved canonical local template IDs and added online-template overrides for Neural Mechanics and Saad-Solla, using the IDs currently deployed by the online API.
  • Added rendered-link coverage for all 16 reproduction pages plus first-graph, in both English and Chinese builds.
  • Added open_template to the required i18n UI-key coverage.

Local verification: 78 relevant docs tests and Ruff passed.

The new CI run also hit startup_failure before creating jobs. GitHub reports that this run cannot be retried, so runner/workflow-side investigation is still needed.

@JinxinWonderWorld JinxinWonderWorld left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed at 9ced321.

Approved:

  • Canonical local template IDs remain separate from the deployed online_template_id overrides; Neural Mechanics and Saad–Solla now resolve to the live IDs.
  • The build contract covers all 17 rendered pages in both English and Chinese, including hrefs and localized labels; i18n coverage includes open_template.
  • Verification: 88 relevant docs tests passed, Ruff passed, both Sphinx builds passed, and all 16 unique rendered template IDs were present in the current live template API.

Note: GitHub Actions run 30793558334 is a startup_failure with zero jobs. This is an infrastructure/check-run issue rather than a code failure, but it may still need a rerun or CI repair before merging.

@QuQingY
QuQingY merged commit 933dce5 into MetaCircleAI:main Aug 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants